<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<title></title>
	<style type="text/css">
	/* ZenDoc identity */
	.zendoc { font-family: Arial, Helvetica, sans-serif; margin:3px; }
	.zendoc a:hover { text-decoration:none; }
	.zendoc span.title-comment { font-family: Verdana, Arial, Helvetica, sans-serif; font-size:80%; color:#AAA; }
	.zendoc span.title-zen { color:#26A; font-weight:normal; }
	.zendoc span.title-doc { color:black; font-weight:bold; }
	/* overall */
	html, body, div { margin:0; padding:0; border:none; }
	body { font-family:Arial, Helvetica, sans-serif; font-size:90%; }
	a { text-decoration:none; }
	a:hover { text-decoration:underline; }
	h2 { color:#999; margin:2em 0 0 0; padding:0 2px 0 20px; border-bottom:2px solid #58B; }
	h3 { color:#B36B00; margin-top:3em; }
	dl { margin:.5em 0 3px 0; }
	dt { font-weight:bold; }
	td { vertical-align:top; }
	th { text-align:left; color:#58B; background-color:#E3ECF4; }
	code { font-size:1.1em; }
	/* specific */
	#header { background-color:#EAEAEA; padding:1px; }
	#links { color:#999; background-color:#FFE; border-bottom:1px solid #58B; padding:2px 20px; }
	#links a { color:#999; }
	.content { padding:10px 20px; }
	#class-definition { background-color:#58B; color:white; }
	#class-definition .classkind { font-weight:bold; }
	#class-definition .classkind .package { font-weight:normal; }
	#class-definition .classname { font-size:4em; margin:5px 0; }
	#class-definition .superclassname { padding-left:20px; font-style:italic; }
	#class-definition .implements { padding-left:20px; font-style:italic; }
	#class-info .content { margin:20px; border:1px solid #58B; }
	pre.definition { background-color:#FFE; border:1px solid #E4E29A; padding:3px; }
	.generated {
		font-style:italic;
		font-size:80%;
		color:#666;
		margin:1em 0 0 0;
		padding:5px 20px;
		border-top:1px solid #999;
	}
	/* tables */
	.member-list { border:1px solid #58B; margin:2em 20px; }
	.member-list a { color:#B36B00; }
	.member-list table { border-collapse:collapse; }
	.member-list td { border-top:1px solid #58B; }
	.member-list td.name { width:175px; text-align:right; padding-right:5px; }
	.member-list table { width:100%; }
	.even { background-color:#FFE; }
	.odd { background-color:white; }
	.param .name { color:#666; }
	</style>
</head>

<body>
<div id="page">
	<div id="header">
		<h4 class="zendoc"><a href="http://www.zendoc.org" title="ZenDoc Documentation Tool Home"><span class="title-comment">/**</span><span class="title-zen">Zen</span><span class="title-doc">Doc</span><span class="title-comment">--&gt;</span></a></h4>
	</div>
	<div id="class-definition" class="section">
		<div class="content">
			
			
			
		</div>
		<div id="links">
			<a href="#class-info">Class Information</a>
			
			 | <a href="#class-properties">Properties</a>
			 | <a href="#class-methods">Methods</a>
			
		</div>
	</div>
	
	<div id="class-info" class="section">
		<h2>Class Information</h2>
		<div class="content">
			
			<em>No Class Information Available</em>
			</div>
			
			
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Properties</th></tr>
				<tr class="even">
					<td class="name"><a href="#volume">volume</a></td>
					<td>The volume of the sound</td>
				</tr>
			</table></div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Methods</th></tr>
				<tr class="even">
					<td class="name"><a href="#CfSound">CfSound()</a></td>
					<td>Create an instance of CfSound</td>
				</tr><tr class="odd">
					<td class="name"><a href="#init">init()</a></td>
					<td>Initialize the CfSound</td>
				</tr><tr class="even">
					<td class="name"><a href="#play">play()</a></td>
					<td>To play the sound</td>
				</tr><tr class="odd">
					<td class="name"><a href="#resume">resume()</a></td>
					<td>Resume the sound if stoped or paused</td>
				</tr><tr class="even">
					<td class="name"><a href="#mute">mute()</a></td>
					<td>Mute or unmute the sound</td>
				</tr><tr class="odd">
					<td class="name"><a href="#stop">stop()</a></td>
					<td>Stop the sound</td>
				</tr><tr class="even">
					<td class="name"><a href="#setVolume">setVolume()</a></td>
					<td>Set the volume</td>
				</tr>
			</table></div>
			
			
	</div>
		
	
	<br />
	<div id="class-properties" class="member-group section">
		<h2>Properties</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="volume">volume</h3>
				<pre class="definition"><code>public function set volume(val:Number):void<br />public function get volume():Number</code></pre>
				<div>The volume of the sound</div>
				
			
			
			
			
			</div>
		</div>
	</div>
	<br />
	<div id="class-methods" class="member-group section">
		<h2>Methods</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="CfSound">CfSound()</h3>
				<pre class="definition"><code>public function CfSound():void</code></pre>
				<div>Create an instance of CfSound</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="init">init()</h3>
				<pre class="definition"><code>public function init(sndId:String, loop:Object = 1, isUrl:Boolean = false, mute:Boolean = false):void</code></pre>
				<div>Initialize the CfSound</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>sndId</code></td><td>the id of the sound. If is a internal sound from libray flash, this id is the className</td></tr>
					<tr><td class="name"><code>loop</code></td><td>Indicate if is a loop sound or not</td></tr>
					<tr><td class="name"><code>isUrl</code></td><td>indicate if is an internal or external (isUrl = true) sound</td></tr>
					<tr><td class="name"><code>mute</code></td><td>indicate if the sound is muted as default</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="play">play()</h3>
				<pre class="definition"><code>public function play(fade:Boolean = false, durationFade:Number = 1, startTime:Number = 0, loops:Object = null):void</code></pre>
				<div>To play the sound</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>fade</code></td><td>Indicate if use a fadein</td></tr>
					<tr><td class="name"><code>durationFade</code></td><td>The duration in second of the fadein</td></tr>
					<tr><td class="name"><code>startTime</code></td><td>The start time in second</td></tr>
					<tr><td class="name"><code>loops</code></td><td>Indicate if play the sound in loop. If null, CfSound take the init value of loop.</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="resume">resume()</h3>
				<pre class="definition"><code>public function resume():void</code></pre>
				<div>Resume the sound if stoped or paused</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="mute">mute()</h3>
				<pre class="definition"><code>public function mute(flag:Boolean, fade:Boolean = false, durationFade:Number = 1):void</code></pre>
				<div>Mute or unmute the sound</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>flag</code></td><td>true or false. If true the sound is muted</td></tr>
					<tr><td class="name"><code>fade</code></td><td>Indicate if use a fadein/fadeout</td></tr>
					<tr><td class="name"><code>durationFade</code></td><td>The duration in second of the fadein/fadeout</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="stop">stop()</h3>
				<pre class="definition"><code>public function stop(fade:Boolean = false, durationFade:Number = 1):void</code></pre>
				<div>Stop the sound</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>fade</code></td><td>Indicate if use a fadein/fadeout</td></tr>
					<tr><td class="name"><code>durationFade</code></td><td>The duration in second of the fadein/fadeout</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="setVolume">setVolume()</h3>
				<pre class="definition"><code>public function setVolume(nVolume:Number):void</code></pre>
				<div>Set the volume</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>nVolume</code></td><td>A number between 0 and 1</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div>
		</div>
	</div>
	
	<p class="generated">Page generated: 7:38 pm on June 7, 2010</p>
</div>
</body>
</html>